Anleitung zur Dokumentation eines HTTP-Headers

• Es gibt viele HTTP-Header, die in verschiedenen IETF-Standards definiert sind.
• IANA pflegt ein Register von HTTP-Header-Feldern und Wikipedia listet die bekannten Header-Felder auf, aber nicht alle sind für Webentwickler relevant oder Teil eines offiziellen Standards.
• Wenn es rote Links auf der aktuellen HTTP-Headers-Referenzübersichtsseite gibt, sind diese Header eine gute Wahl zur Dokumentation.
• Im Zweifelsfall, fragen Sie das MDN Web Docs-Team, ob es sinnvoll ist, über den von Ihnen gewählten Header zu schreiben.

• Bestehende HTTP-Header sind in der HTTP-Referenz dokumentiert.
• Es gibt verschiedene Header-Kategorien: Anfrage-Header, Antwort-Header und Repräsentations-Header.
• Finden Sie die Kategorie des Headers, den Sie dokumentieren möchten (beachten Sie, dass einige Header je nach Kontext sowohl Anfrage- als auch Antwort-Header sein können).
• Gehen Sie zu einer vorhandenen Header-Referenzseite, die derselben Kategorie angehört.

• Alle Header-Seiten befinden sich in diesem Verzeichnis: files/en-us/web/http/reference/headers
• Um eine neue Seite zu erstellen, lesen Sie die Anweisungen in unserem Leitfaden zum Erstellen einer Seite.

• Beginnen Sie entweder mit unserer Vorlage für HTTP-Header-Seiten oder verwenden Sie eine kopierte Struktur von einem der bestehenden HTTP-Header-Dokumente, die Sie in Schritt 2 gefunden haben. Die Entscheidung liegt bei Ihnen.

• Schreiben Sie über den neuen HTTP-Header.

• Stellen Sie sicher, dass Sie diese Abschnitte haben:

  • Ein einleitender Text, in dem der Header-Name (fett) im ersten Satz erwähnt und sein Zweck zusammengefasst wird.
  • Ein Informationskasten, der mindestens den Header-Typ und ob der Header ein verbotener Anfrage-Header ist, enthält.
  • Eine Syntaxbox, die alle möglichen Direktiven/Parameter/Werte des HTTP-Headers enthält.
  • Ein Abschnitt, der diese Direktiven/Werte erklärt.
  • Ein Beispielabschnitt, der eine praktische Nutzung dieses Headers zeigt oder wo und wie er üblicherweise vorkommt.
  • Ein Abschnitt zur Spezifikation, der relevante RFC-Standarddokumente auflistet.
  • Ein "Siehe auch"-Abschnitt, der relevante Ressourcen auflistet.

• Wenn Sie sich andere HTTP-Header-Seiten angesehen haben, werden Sie sehen, dass es ein {{Compat}}-Makro gibt, das für Sie eine Browsertabelle ausfüllt.
• Die Kompatibilitätstabellenseite wird aus strukturierten Daten generiert. Wenn Sie Daten beitragen möchten, schauen Sie sich bitte die Anweisungen unter https://github.com/mdn/browser-compat-data/blob/main/README.md an und senden Sie uns einen Pull-Request.

Stellen Sie sicher, dass Ihr Header in einer geeigneten Kategorie auf der HTTP-Headers-Referenzübersichtsseite aufgelistet ist.

Nachdem Sie die Header-Seite erstellt haben, reichen Sie sie als Pull-Request ein. Ein Mitglied unseres Überprüfungsteams wird automatisch zugewiesen, um Ihre Seite zu überprüfen.